List Projects

Returns a paginated list of all projects available within the tenant.

GET{accelqLoginUrl}/awb/api/2.0/{tenantCode}/administration/projects

Headers

Header	Value
`user_id`	Login username (email)
`api_key`	API key of the user for authentication
`Content-Type`	application/json
`Accept`	application/json

Parameters

Parameter	Type	Required	Description
`accelqLoginUrl`	string	Yes	The AccelQ login URL for API access.
`tenantCode`	string	Yes	Tenant code for identifying the organization.
`page`	integer	No	Page number to retrieve
`size`	integer	No	Number of items per page (maximum: 100)
`user_id`	string	Yes	Login username (email)
`api_key`	string	Yes	API key of the user for authentication

Responses

200 - Paginated list of projects

json

{
  "page": 1,
  "pageSize": 4,
  "totalPages": 10,
  "totalItems": 15,
  "results": [
    {
      "pid": 1,
      "projectDisplayName": "New Project",
      "projectCode": "NewProject",
      "description": "Description for the new project",
      "createdUserPid": 1,
      "createdTimestamp": 1629040036528
    },
    {
      "pid": 3,
      "projectDisplayName": "Acme Project",
      "projectCode": "AcmeProject",
      "description": "Description for the acme project",
      "createdUserPid": 1,
      "createdTimestamp": 1898040036528,
      "branchPath": [
        "New Project"
      ]
    },
    {
      "pid": 6,
      "projectDisplayName": "Test Project",
      "projectCode": "TestProject",
      "description": "Description for the new project",
      "createdUserPid": 1,
      "createdTimestamp": 1828040036528,
      "branchPath": [
        "New Project",
        "Acme Project"
      ]
    },
    {
      "pid": 7,
      "projectDisplayName": "Sanity Project",
      "projectCode": "SanityProject",
      "description": "Description",
      "createdUserPid": 1,
      "createdTimestamp": 1728040036528,
      "branchPath": [
        "New Project",
        "Acme Project",
        "Test Project"
      ],
      "lastMergeInfo": {
        "userPid": 1,
        "mergeTimeStamp": 1751012484566,
        "mergeDescription": "Merging UI component changes",
        "sourceProjectPath": [
          "New Project",
          "Acme Project"
        ]
      }
    }
  ]
}

400 - Invalid page number or page size

json

{
  "error": "Requested page exceeds available pages."
}

403 - Forbidden - User does not have permission

json

{
  "error": "User do not have authorization to access this feature."
}

cURL Command Builder

URL Parameters

accelqLoginUrl (string) *

tenantCode (string) *

page (integer)

size (integer)

Headers

user_id (string) *

api_key (string) *

Request Sample (cURL)

curl -X GET "${{accelqLoginUrl}}/awb/api/2.0/${{tenantCode}}/administration/projects?page=${{page}}&size=${{size}}" \
  -H "user_id: ${{user_id}}" \
  -H "api_key: ${{api_key}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"